This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.
This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.
| The list of the themes | Global methods by category | Global methods by name | The list of the classes | The list of the controls |
class Menubar | ||||
| class, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | ||
|
Function:
Gives access to the Mac menubar. | ||||
|
Example:
dim mb as menuBar mb=new menuBar mb.PreferencesMenuVisible=false // hide Prefercences Menu | ||||
CreateStandardWindowMenu | ||||
| method, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: does nothing. | Mac OS Carbon: Works. | Windows: does nothing. | ||
|
Function:
Creates the standard Carbon Window menu. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.CreateStandardWindowMenu | ||||
|
Notes:
Only works in Carbon. | ||||
Item(index as integer) as menu | ||||
| property, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> nil. | ||
|
Function:
Returns the menu from the menubar at position index. | ||||
|
Example:
dim mb as menuBar dim m as menu mb=new menubar m=mb.Item(4) // get menu number 4 | ||||
MenuBarVisible as Boolean | ||||
| property, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> true. | ||
|
Function:
Returns the menu from the menubar at position index. | ||||
|
Example:
dim mb as menuBar dim m as menu mb=new menubar m=mb.Item(4) // get menu number 4 | ||||
|
Notes:
Requires Mac OS 8.5 or newer to work. | ||||
PreferencesMenuCommandKey as string | ||||
| property, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> "". | ||
|
Function:
The command key of the preferences menu entry on Mac OS X. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.PreferencesMenuCommandKey="K" | ||||
PreferencesMenuEnabled as Boolean | ||||
| property, Menu | Do, 15. Aug 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> false. | ||
|
Function:
True if the Mac OS X Preferences Menu is enabled. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.PreferencesMenuEnabled=true // enable the pref menu | ||||
|
Notes:
In RB 4.5 use the PrefMenuItem instead of this function. For Mac OS 9 or Windows you need to make another Pref Menu Entry which you hide if you are running on Mac OS X like this: #if debugbuild then #else // if not debuging #if targetcarbon then // if carbon if system.runningOnCarbonX then // if on Mac OS X EditPreferences.visible=False EditPreferencesLine.visible=False // Remove our lines from the Edit menu end if #endif #endif In the HandleAppleEvent Eventhandler in the application subclass you get an event of ID "pref" if your application is run on Mac OS X outside the Realbasic IDE. | ||||
PreferencesMenuIconResID as integer | ||||
| property, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> 0. | ||
|
Function:
The ID of a CICN Resource in use as an icon for the preferences menu entry on Mac OS X. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.PreferencesMenuIconResID=257 | ||||
|
Notes:
ID needs to be in Range between 256 and 511. | ||||
PreferencesMenuSeparatorVisible as boolean | ||||
| property, Menu | Sa, 27. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> true. | ||
|
Function:
whether the line below the preferences menu entry on Mac OS X is visible. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.PreferencesMenuVisible=false // hide it mb.PreferencesMenuSeparatorVisible=false // hide line below | ||||
PreferencesMenuText as string | ||||
| property, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> "". | ||
|
Function:
The text of the preferences menu entry on Mac OS X. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.PreferencesMenuText="My applications preferences..." | ||||
PreferencesMenuVisible as boolean | ||||
| property, Menu | Sa, 27. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> true. | ||
|
Function:
whether the preferences menu entry on Mac OS X is visible. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.PreferencesMenuVisible=false // hide it mb.PreferencesMenuSeparatorVisible=false // hide line below | ||||
QuitMenuCommandKey as string | ||||
| property, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> "". | ||
|
Function:
The command key of the Quit menu entry on Mac OS X. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.QuitMenuCommandKey="K" | ||||
QuitMenuIconResID as integer | ||||
| property, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> 0. | ||
|
Function:
The ID of a CICN Resource in use as an icon for the Quit menu entry on Mac OS X. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.QuitMenuIconResID=257 | ||||
|
Notes:
ID needs to be in Range between 256 and 511. | ||||
QuitMenuSeparatorVisible as boolean | ||||
| property, Menu | Sa, 27. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> true. | ||
|
Function:
whether the line below the Quit menu entry on Mac OS X is visible. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.QuitMenuVisible=false // hide it mb.QuitMenuSeparatorVisible=false // hide line below | ||||
QuitMenuText as string | ||||
| property, Menu | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> "". | ||
|
Function:
The text of the Quit menu entry on Mac OS X. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.QuitMenuText="My applications Quit..." | ||||
QuitMenuVisible as boolean | ||||
| property, Menu | Sa, 27. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: -> true. | ||
|
Function:
whether the Quit menu entry on Mac OS X is visible. | ||||
|
Example:
dim mb as menuBar mb=new menubar mb.QuitMenuVisible=false // hide it mb.QuitMenuSeparatorVisible=false // hide line below | ||||
Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.